/**
 * @file Display.h
 * @brief  GDR functions that alter the display of a graph
 * @author Matt Stallmann @date 17 Dec 2001
 * $Id: Display.h 10 2007-06-28 20:08:57Z mfms $
 */

/*
 *  Copyright (C) 2001  Matthias Stallmann.
 *  Contact: matt_stallmann@ncsu.edu
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program (file COPYING.txt); if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 *  USA.
 */

#ifndef DISPLAY_H
#define DISPLAY_H

extern void init_display_attributes();
/**< initialize all display attributes of the graph (nothing highlighted, only
   non-empty labels exposed, no hidden edges */

extern void highlight_vertex(vertex vx);
/**< highlights 'vx' by making its background white instead of black */

extern void un_highlight_vertex(vertex vx);
/**< makes 'vx' unhighlighted */

extern void highlight_edge(edge ej);
/**< highlights 'ej' by making it thicker */

extern void un_highlight_edge(edge ej);
/**< makes 'ej' unhighlighted */

extern int is_displayed_edge(edge e);
/**< returns TRUE iff 'e' is showing on the display */

extern void display_edge(edge e);
/**< displays the edge 'e' */

extern void hide_edge(edge e);
/**< removes 'e' from the display */

extern int is_exposed_vertex_label(vertex vx);
/**< returns TRUE iff 'vx' is a valid vertex whose label is exposed */

extern int is_exposed_edge_label(edge ej);
/**< returns TRUE iff 'ej' is a non-null edge whose label is exposed */

extern int is_highlighted_vertex(vertex vx);
/**< returns TRUE iff 'vx' is valid and highlighted */

extern int is_highlighted_edge(edge ej);
/**< returns TRUE iff 'ej' is a non-null edge and highlighted */

extern void expose_vertex_label(vertex vx);
/**< causes the label of vertex 'vx' to be displayed */

extern void hide_vertex_label(vertex vx);
/**< causes the label of vertex 'vx' to be hidden from view */

extern void expose_edge_label(edge ej);
/**< causes the label of edge 'ej' to be displayed */

extern void hide_edge_label(edge ej);
/**< causes the label of edge 'ej' to be hidden from view */

#endif
/* end of Display.h */

/*  [Last modified: 2007 06 28 at 19:14:52 GMT] */
